﻿/* ----------------------------------------------------------------------------
 * Copyright (c) Philip Stears 
 *
 * This source code is subject to terms and conditions of the Microsoft Public 
 * License (Ms-PL).
 * 
 * By using this source code in any fashion, you are agreeing to be bound 
 * by the terms of the Microsoft Public License.
 * 
 * To request a copy of the Microsoft Public License, send a request by email
 * to license@connectbasic.net.
 *
 * This notice must not be removed from this software.
 * ---------------------------------------------------------------------------- */

namespace ConnectBasic.Shell.Extensibility
{
    using System.Drawing;

    /// <summary>
    /// Represents an item in a project, e.g. a standard module.
    /// </summary>
    public interface IProjectItem
    {

        /// <summary>
        /// Gets the name of the item.
        /// </summary>
        string Name { get; }

        /// <summary>
        /// Gets the small image which represents the item.
        /// </summary>
        /// <returns></returns>
        Image GetSmallImage();

        /// <summary>
        /// Gets a unique name assigned to the small image.
        /// </summary>
        /// <returns></returns>
        string SmallImageKey { get; }
    }
}
